smartbuck8.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2020 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** Permission is hereby granted, free of charge, to any person obtaining a copy
** of this software and associated documentation files (the "Software"), to deal
** in the Software without restriction, including without limitation the rights
** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
** copies of the Software, and to permit persons to whom the Software is
** furnished to do so, subject to the following conditions:
** The above copyright notice and this permission notice shall be
** included in all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
**  USE OR OTHER DEALINGS IN THE SOFTWARE.
****************************************************************************/

 
#ifndef SMARTBUCK8_H
#define SMARTBUCK8_H
 
#ifdef __cplusplus
extern "C"{
#endif

#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_i2c_master.h"




#define SMARTBUCK8_REG_VOUT                     0x01
#define SMARTBUCK8_REG_CONTROL                  0x03
#define SMARTBUCK8_REG_STATUS                   0x05
 // smartbuck8_reg



#define SMARTBUCK8_CONTROL_RESET                0x80
#define SMARTBUCK8_CONTROL_EN_FPWM_ON_CHANGE    0x40
#define SMARTBUCK8_CONTROL_SOFT_EN              0x20
#define SMARTBUCK8_CONTROL_EN_FPWM              0x10
#define SMARTBUCK8_CONTROL_EN_OUT_DISCHARGE     0x08
#define SMARTBUCK8_CONTROL_EN_HICCUP            0x04
#define SMARTBUCK8_CONTROL_V_RAMP_SPEED_0_25US  0x00
#define SMARTBUCK8_CONTROL_V_RAMP_SPEED_0_5US   0x01
#define SMARTBUCK8_CONTROL_V_RAMP_SPEED_1US     0x02
#define SMARTBUCK8_CONTROL_V_RAMP_SPEED_5US     0x03
#define SMARTBUCK8_CONTROL_V_RAMP_SPEED_MASK    0x03

#define SMARTBUCK8_STATUS_THERMAL_WARNING       0x10
#define SMARTBUCK8_STATUS_HICCUP                0x08
#define SMARTBUCK8_STATUS_UVLO                  0x01

#define SMARTBUCK8_VOUT_MV_MIN                  400
#define SMARTBUCK8_VOUT_MV_MAX                  1675
#define SMARTBUCK8_VOUT_MV_STEP_5MV             5

#define SMARTBUCK8_DEVICE_ADDRESS               0x42
 // smartbuck8_set



#define SMARTBUCK8_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.pon = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.en = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.pg = MIKROBUS( mikrobus, MIKROBUS_INT )
 // smartbuck8_map // smartbuck8

typedef struct
{
    // Output pins
    digital_out_t pon;          
    digital_out_t en;           
 
    // Input pins
    digital_in_t pg;            
 
    // Modules
    i2c_master_t i2c;           
 
    // I2C slave address
    uint8_t slave_address;      
 
} smartbuck8_t;

typedef struct
{
    pin_name_t scl;             
    pin_name_t sda;             
 
    pin_name_t pon;             
    pin_name_t en;              
    pin_name_t pg;              
 
    uint32_t   i2c_speed;       
    uint8_t    i2c_address;     
 
} smartbuck8_cfg_t;

typedef enum
{
    SMARTBUCK8_OK = 0,
    SMARTBUCK8_ERROR = -1
 
} smartbuck8_return_value_t;


void smartbuck8_cfg_setup ( smartbuck8_cfg_t *cfg );

err_t smartbuck8_init ( smartbuck8_t *ctx, smartbuck8_cfg_t *cfg );

err_t smartbuck8_default_cfg ( smartbuck8_t *ctx );

err_t smartbuck8_write_reg ( smartbuck8_t *ctx, uint8_t reg, uint8_t data_in );

err_t smartbuck8_read_reg ( smartbuck8_t *ctx, uint8_t reg, uint8_t *data_out );

void smartbuck8_enable_power ( smartbuck8_t *ctx );

void smartbuck8_disable_power ( smartbuck8_t *ctx );

void smartbuck8_enable_device ( smartbuck8_t *ctx );

void smartbuck8_disable_device ( smartbuck8_t *ctx );

uint8_t smartbuck8_get_pg_pin ( smartbuck8_t *ctx );

err_t smartbuck8_read_status ( smartbuck8_t *ctx, uint8_t *status );

err_t smartbuck8_set_control ( smartbuck8_t *ctx, uint8_t control );

err_t smartbuck8_set_vout ( smartbuck8_t *ctx, uint16_t vout_mv );
 
#ifdef __cplusplus
}
#endif
#endif // SMARTBUCK8_H
 // smartbuck8
 
// ------------------------------------------------------------------------ END